<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
    PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<!-- /fasttmp/mkdist-qt-4.3.5-1211793125/qtopia-core-opensource-src-4.3.5/src/gui/text/qtextformat.cpp -->
<head>
  <title>Qt 4.3: QTextListFormat Class Reference</title>
  <link href="classic.css" rel="stylesheet" type="text/css" />
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left" valign="top" width="32"><a href="http://www.trolltech.com/products/qt"><img src="images/qt-logo.png" align="left" width="32" height="32" border="0" /></a></td>
<td width="1">&nbsp;&nbsp;</td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a>&nbsp;&middot; <a href="classes.html"><font color="#004faf">All&nbsp;Classes</font></a>&nbsp;&middot; <a href="mainclasses.html"><font color="#004faf">Main&nbsp;Classes</font></a>&nbsp;&middot; <a href="groups.html"><font color="#004faf">Grouped&nbsp;Classes</font></a>&nbsp;&middot; <a href="modules.html"><font color="#004faf">Modules</font></a>&nbsp;&middot; <a href="functions.html"><font color="#004faf">Functions</font></a></td>
<td align="right" valign="top" width="230"><a href="http://www.trolltech.com"><img src="images/trolltech-logo.png" align="right" width="203" height="32" border="0" /></a></td></tr></table><h1 align="center">QTextListFormat Class Reference<br /><sup><sup>[<a href="qtgui.html">QtGui</a> module]</sup></sup></h1>
<p>The QTextListFormat class provides formatting information for lists in a <a href="qtextdocument.html">QTextDocument</a>. <a href="#details">More...</a></p>
<pre> #include &lt;QTextListFormat&gt;</pre><p>Inherits <a href="qtextformat.html">QTextFormat</a>.</p>
<ul>
<li><a href="qtextlistformat-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h3>Public Types</h3>
<ul>
<li><div class="fn"/>enum <b><a href="qtextlistformat.html#Style-enum">Style</a></b> { ListDisc, ListCircle, ListSquare, ListDecimal, ListLowerAlpha, ListUpperAlpha }</li>
</ul>
<a name="public-functions"></a>
<h3>Public Functions</h3>
<ul>
<li><div class="fn"/><b><a href="qtextlistformat.html#QTextListFormat">QTextListFormat</a></b> ()</li>
<li><div class="fn"/>int <b><a href="qtextlistformat.html#indent">indent</a></b> () const</li>
<li><div class="fn"/>bool <b><a href="qtextlistformat.html#isValid">isValid</a></b> () const</li>
<li><div class="fn"/>void <b><a href="qtextlistformat.html#setIndent">setIndent</a></b> ( int <i>indentation</i> )</li>
<li><div class="fn"/>void <b><a href="qtextlistformat.html#setStyle">setStyle</a></b> ( Style <i>style</i> )</li>
<li><div class="fn"/>Style <b><a href="qtextlistformat.html#style">style</a></b> () const</li>
</ul>
<ul>
<li><div class="fn"/>47 public functions inherited from <a href="qtextformat.html#public-functions">QTextFormat</a></li>
</ul>
<a name="details"></a>
<hr />
<h2>Detailed Description</h2>
<p>The QTextListFormat class provides formatting information for lists in a <a href="qtextdocument.html">QTextDocument</a>.</p>
<p>A list is composed of one or more items, represented as text blocks. The list's format specifies the appearance of items in the list. In particular, it determines the indentation and the style of each item.</p>
<p>The indentation of the items is an integer value that causes each item to be offset from the left margin by a certain amount. This value is read with <a href="qtextlistformat.html#indent">indent</a>() and set with <a href="qtextlistformat.html#setIndent">setIndent</a>().</p>
<p>The style used to decorate each item is set with <a href="qtextlistformat.html#setStyle">setStyle</a>() and can be read with the <a href="qtextlistformat.html#style">style</a>() function. The style controls the type of bullet points and numbering scheme used for items in the list. Note that lists that use the decimal numbering scheme begin counting at 1 rather than 0.</p>
<p>See also <a href="qtextlist.html">QTextList</a>.</p>
<hr />
<h2>Member Type Documentation</h2>
<h3 class="fn"><a name="Style-enum"></a>enum QTextListFormat::Style</h3>
<p>This enum describes the symbols used to decorate list items:</p>
<p><table border="1" cellpadding="2" cellspacing="1" width="100%">
<tr><th width="25%">Constant</th><th width="15%">Value</th><th width="60%">Description</th></tr>
<tr><td valign="top"><tt>QTextListFormat::ListDisc</tt></td><td align="center" valign="top"><tt>-1</tt></td><td valign="top">a filled circle</td></tr>
<tr><td valign="top"><tt>QTextListFormat::ListCircle</tt></td><td align="center" valign="top"><tt>-2</tt></td><td valign="top">an empty circle</td></tr>
<tr><td valign="top"><tt>QTextListFormat::ListSquare</tt></td><td align="center" valign="top"><tt>-3</tt></td><td valign="top">a filled square</td></tr>
<tr><td valign="top"><tt>QTextListFormat::ListDecimal</tt></td><td align="center" valign="top"><tt>-4</tt></td><td valign="top">decimal values in ascending order</td></tr>
<tr><td valign="top"><tt>QTextListFormat::ListLowerAlpha</tt></td><td align="center" valign="top"><tt>-5</tt></td><td valign="top">lower case Latin characters in alphabetical order</td></tr>
<tr><td valign="top"><tt>QTextListFormat::ListUpperAlpha</tt></td><td align="center" valign="top"><tt>-6</tt></td><td valign="top">upper case Latin characters in alphabetical order</td></tr>
</table></p>
<hr />
<h2>Member Function Documentation</h2>
<h3 class="fn"><a name="QTextListFormat"></a>QTextListFormat::QTextListFormat ()</h3>
<p>Constructs a new list format object.</p>
<h3 class="fn"><a name="indent"></a>int QTextListFormat::indent () const</h3>
<p>Returns the list format's indentation.</p>
<p>See also <a href="qtextlistformat.html#setIndent">setIndent</a>().</p>
<h3 class="fn"><a name="isValid"></a>bool QTextListFormat::isValid () const</h3>
<p>Returns true if this list format is valid; otherwise returns false.</p>
<h3 class="fn"><a name="setIndent"></a>void QTextListFormat::setIndent ( int <i>indentation</i> )</h3>
<p>Sets the list format's <i>indentation</i>.</p>
<p>See also <a href="qtextlistformat.html#indent">indent</a>().</p>
<h3 class="fn"><a name="setStyle"></a>void QTextListFormat::setStyle ( <a href="qtextlistformat.html#Style-enum">Style</a> <i>style</i> )</h3>
<p>Sets the list format's <i>style</i>. See <tt>Style</tt> for the available styles.</p>
<p>See also <a href="qtextlistformat.html#style">style</a>().</p>
<h3 class="fn"><a name="style"></a><a href="qtextlistformat.html#Style-enum">Style</a> QTextListFormat::style () const</h3>
<p>Returns the list format's style. See <tt>Style</tt>.</p>
<p>See also <a href="qtextlistformat.html#setStyle">setStyle</a>().</p>
<p /><address><hr /><div align="center">
<table width="100%" cellspacing="0" border="0"><tr class="address">
<td width="30%">Copyright &copy; 2008 <a href="trolltech.html">Trolltech</a></td>
<td width="40%" align="center"><a href="trademarks.html">Trademarks</a></td>
<td width="30%" align="right"><div align="right">Qt 4.3.5</div></td>
</tr></table></div></address></body>
</html>
